Crate floating_ui_dom

Rust port of Floating UI.

This is the library to use Floating UI on the web, wrapping floating_ui_core with DOM interface logic.

See @floating-ui/dom for the original package.

Re-exports

• pub use floating_ui_utils::dom;
• pub use floating_ui_utils::AlignedPlacement;
• pub use floating_ui_utils::Alignment;
• pub use floating_ui_utils::Axis;
• pub use floating_ui_utils::ClientRectObject;
• pub use floating_ui_utils::Coords;
• pub use floating_ui_utils::Dimensions;
• pub use floating_ui_utils::ElementRects;
• pub use floating_ui_utils::Length;
• pub use floating_ui_utils::Padding;
• pub use floating_ui_utils::PartialSideObject;
• pub use floating_ui_utils::Placement;
• pub use floating_ui_utils::Rect;
• pub use floating_ui_utils::Side;
• pub use floating_ui_utils::SideObject;
• pub use floating_ui_utils::Strategy;
• pub use floating_ui_utils::VirtualElement;

Structs

• ApplyState
  State passed to SizeOptions::apply.
• ArrowData
  Data stored by Arrow middleware.
• ArrowOptions
  Options for Arrow.
• AutoPlacementData
  Data stored by AutoPlacement middleware.
• AutoPlacementDataOverflow
  An overflow stored in AutoPlacementData.
• AutoPlacementOptions
  Options for AutoPlacement middleware.
• AutoUpdateOptions
  Options for auto_update.
• ComputePositionConfig
  Options for compute_position.
• ComputePositionReturn
  Return of compute_position.
• DefaultLimiter
  Default Limiter, which doesn’t limit shifting.
• DetectOverflowOptions
  Options for detect_overflow.
• FlipData
  Data stored by Flip middleware.
• FlipDataOverflow
  An overflow stored in FlipData.
• FlipOptions
  Options for Flip middleware.
• HideData
  Data stored by Hide middleware.
• HideOptions
  Options for Hide middleware.
• InlineOptions
  Options for Inline.
• LimitShift
  Built-in Limiter, that will stop Shift at a certain point.
• LimitShiftOffsetValues
  Axes configuration for LimitShiftOffset.
• LimitShiftOptions
  Options for LimitShift limiter.
• MiddlewareData
  Data stored by middleware.
• MiddlewareReturn
  Return of Middleware::compute.
• MiddlewareState
  State passed to Middleware::compute.
• OffsetData
  Data stored by Offset middleware.
• OffsetOptionsValues
  Axes configuration for OffsetOptions.
• ShiftData
  Data stored by Shift middleware.
• ShiftOptions
  Options for Shift middleware.
• SizeOptions
  Options for Size middleware.

Enums

• Boundary
• Derivable
• ElementContext
• FallbackStrategy
  Fallback strategy used by Flip middleware.
• HideStrategy
  Fallback strategy used by Hide middleware.
• LimitShiftOffset
  Offset configuration for LimitShiftOptions.
• OffsetOptions
  Options for Offset middleware.
• RootBoundary

Constants

• ARROW_NAME
  Name of the Arrow middleware.
• AUTO_PLACEMENT_NAME
  Name of the AutoPlacement middleware.
• FLIP_NAME
  Name of the Flip middleware.
• HIDE_NAME
  Name of the Hide middleware.
• INLINE_NAME
  Name of the Inline middleware.
• OFFSET_NAME
  Name of the Offset middleware.
• SHIFT_NAME
  Name of the Shift middleware.
• SIZE_NAME
  Name of the Size middleware.

Traits

• Middleware
  Middleware used by compute_position.
• MiddlewareWithOptions
  Middleware with options.

Functions

• auto_update
  Automatically updates the position of the floating element when necessary. Should only be called when the floating element is mounted on the DOM or visible on the screen.
• compute_position
  Computes the x and y coordinates that will place the floating element next to a given reference element.

Type Aliases

• Arrow
  Provides data to position an inner element of the floating element so that it appears centered to the reference element.
• AutoPlacement
  Optimizes the visibility of the floating element by choosing the placement that has the most space available automatically, without needing to specify a preferred placement. Alternative to Flip.
• DefaultVirtualElement
• DerivableFn
• ElementOrVirtual
• Flip
  Optimizes the visibility of the floating element by flipping the placement in order to keep it in view when the preferred placement(s) will overflow the clipping boundary. Alternative to AutoPlacement.
• Hide
  Provides data to hide the floating element in applicable situations, such as when it is not in the same clipping context as the reference element.
• Inline
  Provides improved positioning for inline reference elements that can span over multiple lines, such as hyperlinks or range selections.
• MiddlewareVec
  Vector of middleware used in ComputePositionConfig.
• Offset
  Modifies the placement by translating the floating element along the specified axes.
• OwnedElementOrVirtual
• Shift
  Optimizes the visibility of the floating element by shifting it in order to keep it in view when it will overflow the clipping boundary.
• Size
  Provides data that allows you to change the size of the floating element - for instance, prevent it from overflowing the clipping boundary or match the width of the reference element.